Skip to content

Clarify website onboarding and fork staging previews - #908

Merged
richarddushime merged 8 commits into
mainfrom
docs/contributor-guide
Oct 28, 2026
Merged

richarddushime merged 8 commits into
mainfrom
docs/contributor-guide

Conversation

@LukasWallrich

@LukasWallrich LukasWallrich commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

Make the website contribution guide usable for first-time contributors: add browser-only content edits, correct fork/sync/push commands, pin Hugo Extended 0.158.0 to the workflows, and explain generated content and fork staging previews. Clarify the existing repository and contribution licences and link FORRT's Code of Conduct.

Validation: checked commands and staging behaviour against current deploy workflows; checked local link targets and the canonical conduct URL; git diff --check passed. Opus 5.5 reviewed the guide, its findings were applied, and a final review approved it. Documentation only; no site build or deployment was run.


Summary by cubic

Documents the FORRT website contribution guide for first-time contributors and clarifies how fork staging previews work.

  • Adds a browser-only workflow for fixing text or broken links without installing Git or Hugo, and names generated content that must be changed via its source form.
  • Corrects the fork, sync, and push commands for both git and RStudio setups, and documents the spell-check feedback, the monthly PR report, and the maintainer-run single_pr preview for forks.
  • Notes that any recent Hugo Extended version works locally while production and staging use 0.158.0.
  • Separates the repository licence (CC BY-NC-SA 4.0) from the contribution policy (CC BY 4.0) and links the Code of Conduct.

Written for commit 2db72ed. Summary will update on new commits.

View guided diff Turn on auto-fix

@LukasWallrich
LukasWallrich requested a review from a team as a code owner October 8, 2026 12:13
@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

👍 All image files/references (if any) are in webp format, in line with our policy.

@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

📝 Spell Check Results

Found 2 potential spelling issue(s) when checking 15 changed file(s):

📄 content/just_os_chatbot/intro.md

Line Issue
38 Asai ==> Asia
42 Asai ==> Asia

ℹ️ How to address these issues:

  1. Fix the typo: If it's a genuine typo, please correct it.
  2. Add to whitelist: If it's a valid word (e.g., a name, technical term), add it to .codespell-ignore.txt
  3. False positive: If this is a false positive, please report it in the PR comments.

🤖 This check was performed by codespell

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 1 file

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="CONTRIBUTING.md">

<violation number="1" location="CONTRIBUTING.md:196">
P3: Monthly reports omit skipped PR numbers when every attempted PR conflicts because the workflow only emits that section when at least one PR was included. Fix the summary condition or qualify this documentation.</violation>
</file>

Reply with feedback, questions, or to request a fix.

View guided diff | Turn on auto-fix | Re-trigger cubic

Comment thread CONTRIBUTING.md Resolved
Comment thread CONTRIBUTING.md Resolved
Comment thread CONTRIBUTING.md Resolved
@LukasWallrich

LukasWallrich commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor Author

✅ Staging Deployment Status

This PR has been successfully deployed to staging as part of an aggregated deployment.

Deployed at: 2026-10-28 18:26:37 UTC
Staging URL: https://staging.forrt.org

The staging site shows the combined state of all compatible open PRs.

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 1 file (changes from recent commits).

Reply with feedback, questions, or to request a fix.

View guided diff | Turn on auto-fix | Re-trigger cubic

Comment thread CONTRIBUTING.md Resolved
Comment thread CONTRIBUTING.md Resolved
Comment thread CONTRIBUTING.md Resolved
Comment thread CONTRIBUTING.md Resolved

@richarddushime richarddushime left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made fews comments

A suggestion would be adding a line about the Spell Checker(spelling issues found ) on each PR

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@LukasWallrich

Copy link
Copy Markdown
Contributor Author

Addressed @richarddushime's review: Hugo version is now optional for local development, draft-PR exclusion from staging is explicit, and step 6 of the contribution workflow describes the PR spell checker (comment on same-repo PRs, workflow summary on forks, .codespell-ignore.txt for valid words).

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 1 file (changes from recent commits).

Reply with feedback, questions, or to request a fix.

View guided diff | Turn on auto-fix | Re-trigger cubic

Comment thread CONTRIBUTING.md Resolved
Comment thread CONTRIBUTING.md Resolved
LukasWallrich and others added 3 commits October 28, 2026 17:22
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>

@richarddushime richarddushime left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@richarddushime
richarddushime merged commit 1395f47 into main Oct 28, 2026
5 checks passed
@richarddushime
richarddushime deleted the docs/contributor-guide branch October 28, 2026 20:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants